dbt-materialize: Support connection overrides by SangJunBak · Pull Request #36127 · MaterializeInc/materialize

SangJunBak · 2026-04-16T22:11:44Z

Motivation

Unblocks OIDC auth because our dbt adapter doesn't allow inputting arbitrary options: https://materializeinc.slack.com/archives/C0A23PK183Z/p1776360806044789

Verification

Had a local materialize instance running via bin/environmentd
Saved following profiles.yml in the current directory:

dbt_test:
  target: dev
  outputs:
    dev:
      type: materialize
      host: localhost
      port: 6875
      user: materialize
      pass: materialize
      database: materialize
      schema: public
      options:
        oidc_auth_enabled: "true"
        welcome_message: "on"

Ran

cd misc/dbt-materialize
uv venv dbt-venv
uv pip install --python dbt-venv/bin/python pip
dbt-venv/bin/pip install .
dbt-venv/bin/dbt debug --profiles-dir .

Verified output had:

18:43:49    application_name: dbt-materialize v1.9.8
18:43:49    options: {'oidc_auth_enabled': 'true', 'welcome_message': 'on'}

Wasn't sure the best way to automate a unit test for this however.

SangJunBak · 2026-04-17T18:59:18Z

@bobbyiliev Unsure how we actually deploy an update to our dbt adapter!

Also I decided to go with the approach of allowing an options override instead of accepting a oidc_auth_enabled boolean as a connection option. This is because:

This oidc_auth_enabled option doesn't exist for cloud
Future flexibility if we need to specify a connection option

Purpose is to allow OIDC auth via the oidc_auth_enabled connection option variable. - Removes the initial monkey patch - Copies much of the implementation in PGConnectionManager

bobbyiliev · 2026-04-22T07:51:08Z

@bobbyiliev Unsure how we actually deploy an update to our dbt adapter!

@SangJunBak This gets auto released after bumping the version bump (version.py + setup.py). What we usually do is to split the version bump itself out into a follow-up release PR. We usually merge the feature + CHANGELOG entry first, then do a separate PR to cut the release to PyPI.

Would you mind reverting the verions bump and adding a changelog entry here? Then we can have a follow-up PR for the release itself. That way if there are other pending changes they all get released together.

bobbyiliev · 2026-04-22T07:55:53Z

Ran

cd misc/dbt-materialize
uv venv dbt-venv
uv pip install --python dbt-venv/bin/python pip
dbt-venv/bin/pip install .
dbt-venv/bin/dbt debug --profiles-dir .

Did you by any chance test this with a full dbt run / dbt build, not just dbt debug? The verification shows the options making it into the connection string, but I'd feel better knowing a real query round-trip works with an override that actually changes behavior (e.g. setting auto_route_catalog_queries: off). Happy to try this on my end if you hit any blockers setting this all up!

bobbyiliev · 2026-04-22T07:54:06Z

+  options:
+    hint: 'overrides the PostgreSQL `options` connection parameter'


I totally hear you that this is tricky to unit-test, but do you think we could add an integration test in tests/adapter/ e.g. set a non-default option like welcome_message: on via a dbt_profile_target override and assert the server honored it? The options_dict.update(credentials.options) merge is the whole point of the feature. Happy to help sketch something out if useful!

bobbyiliev · 2026-04-22T07:57:20Z

    @classmethod
    def open(cls, connection):
-        connection = super().open(connection)
+        # Much of the `open` method setup is copied from the `PostgresConnectionManager.open` method
+        # https://github.com/dbt-labs/dbt-adapters/blob/v1.17.3/dbt-postgres/src/dbt/adapters/postgres/connections.py#L102,
+        # except we allow users to override options.


This new open method copies a chunk of PostgresConnectionManager.open from dbt-postgres. Did you consider overriding a smaller surface instead (e.g. just the options-string construction and then super().open())? My worry is that when dbt-postgres adds new kwargs or changes retry logic, we'll silently fall behind. Totally fine if you already looked at this and it wasn't workable, just curious.

My worry is that when dbt-postgres adds new kwargs or changes retry logic, we'll silently fall behind

I think this is a valid concern :( I tried to but because kwargs is defined internally and there's no way to override options through the credentials object, we can't use super().open(). The best way I could think of is extending off the previous approach of monkey patching psycopg, then doing some weird python thread blocking such that the monkey patch can accept input from our adapter's .open, but that seems worse than copying their implementation. FWIW prior art to this is something like Clickhouse https://github.com/ClickHouse/dbt-clickhouse/blob/main/dbt/adapters/clickhouse/connections.py

Maybe the correct implementation here however is inheriting off SQLConnectionManager instead of PostgresqlConnectionManager?

bobbyiliev · 2026-04-22T07:58:00Z


 # If you bump this version, bump it in setup.py too.
-version = "1.9.7"
+version = "1.9.8"


Mentioned this in the other comment but could we split the version bump (version.py + setup.py) out of this PR? Normally I prefer to merge the feature + document it under "Unreleased" in the CHANGELOG first, then do a separate release PR that bumps the version and publishes to PyPI. Keeps the feature history and release history cleanly separate.

SangJunBak · 2026-04-22T17:41:01Z

Did you by any chance test this with a full dbt run / dbt build, not just dbt debug? The verification shows the options making it into the connection string, but I'd feel better knowing a real query round-trip works with an override that actually changes behavior (e.g. setting auto_route_catalog_queries: off). Happy to try this on my end if you hit any blockers setting this all up!

I think the verification also tries to connect, so the way I actually tested it was toggling welcome_message to on and off and seeing the output! I can write a unit test for this however!

SangJunBak · 2026-04-22T18:34:51Z

Created an integration test in the latest commit. Can test via bin/mzcompose --find dbt-materialize run default -k test_options_override

SangJunBak · 2026-04-22T18:38:00Z

Followup PR to bump the versions #36213

SangJunBak force-pushed the jun/dbt-oidc branch 2 times, most recently from 7ea9bf0 to 88e356d Compare April 17, 2026 18:36

SangJunBak requested a review from bobbyiliev April 17, 2026 18:37

SangJunBak changed the title ~~dbt-materialize: Support OIDC auth~~ dbt-materialize: Support connection overrides Apr 17, 2026

SangJunBak marked this pull request as ready for review April 17, 2026 18:54

SangJunBak requested a review from a team as a code owner April 17, 2026 18:54

SangJunBak force-pushed the jun/dbt-oidc branch from 88e356d to c2586ce Compare April 17, 2026 18:54

SangJunBak marked this pull request as draft April 20, 2026 15:04

SangJunBak force-pushed the jun/dbt-oidc branch from c2586ce to 0514015 Compare April 20, 2026 15:12

SangJunBak marked this pull request as ready for review April 20, 2026 15:13

dbt-materialize: Support overriding options in dbt adapter

a5eaee4

Purpose is to allow OIDC auth via the oidc_auth_enabled connection option variable. - Removes the initial monkey patch - Copies much of the implementation in PGConnectionManager

SangJunBak force-pushed the jun/dbt-oidc branch from 0514015 to a5eaee4 Compare April 20, 2026 16:09

bobbyiliev requested changes Apr 22, 2026

View reviewed changes

SangJunBak added 2 commits April 22, 2026 14:04

dbt-materialize: Remove version bump and update changelog

8e09b7c

dbt-materialize: Add integration test for connection override

acb1203

SangJunBak requested a review from bobbyiliev April 22, 2026 18:35

SangJunBak mentioned this pull request Apr 22, 2026

Bump dbt-materialize version #36213

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dbt-materialize: Support connection overrides#36127

dbt-materialize: Support connection overrides#36127
SangJunBak wants to merge 3 commits intoMaterializeInc:mainfrom
SangJunBak:jun/dbt-oidc

SangJunBak commented Apr 16, 2026 •

edited

Loading

Uh oh!

SangJunBak commented Apr 17, 2026 •

edited

Loading

Uh oh!

bobbyiliev commented Apr 22, 2026

Uh oh!

bobbyiliev commented Apr 22, 2026

Uh oh!

bobbyiliev Apr 22, 2026

Uh oh!

bobbyiliev Apr 22, 2026

Uh oh!

SangJunBak Apr 22, 2026 •

edited

Loading

Uh oh!

SangJunBak Apr 22, 2026

Uh oh!

bobbyiliev Apr 22, 2026

Uh oh!

SangJunBak Apr 22, 2026

Uh oh!

SangJunBak commented Apr 22, 2026

Uh oh!

SangJunBak commented Apr 22, 2026 •

edited

Loading

Uh oh!

SangJunBak commented Apr 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		options:
		hint: 'overrides the PostgreSQL `options` connection parameter'

Conversation

SangJunBak commented Apr 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Verification

Uh oh!

SangJunBak commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bobbyiliev commented Apr 22, 2026

Uh oh!

bobbyiliev commented Apr 22, 2026

Uh oh!

bobbyiliev Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

bobbyiliev Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

SangJunBak Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SangJunBak Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

bobbyiliev Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

SangJunBak Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

SangJunBak commented Apr 22, 2026

Uh oh!

SangJunBak commented Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SangJunBak commented Apr 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

SangJunBak commented Apr 16, 2026 •

edited

Loading

SangJunBak commented Apr 17, 2026 •

edited

Loading

SangJunBak Apr 22, 2026 •

edited

Loading

SangJunBak commented Apr 22, 2026 •

edited

Loading